1 /*
2 * $Header: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/digester/XMLBeanInfoDigester.java,v 1.1 2002/06/10 17:53:34 jstrachan Exp $
3 * $Revision: 1.1 $
4 * $Date: 2002/06/10 17:53:34 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>;.
59 *
60 * $Id: XMLBeanInfoDigester.java,v 1.1 2002/06/10 17:53:34 jstrachan Exp $
61 */
62 package org.apache.commons.betwixt.digester;
63
64 import java.util.HashSet;
65 import java.util.Set;
66
67 import javax.xml.parsers.SAXParser;
68
69 import org.apache.commons.betwixt.XMLIntrospector;
70
71 import org.apache.commons.digester.Rule;
72 import org.apache.commons.digester.Digester;
73
74 import org.apache.commons.logging.Log;
75 import org.apache.commons.logging.LogFactory;
76
77 import org.xml.sax.XMLReader;
78
79 /*** <p><code>XMLBeanInfoDigester</code> is a digester of XML files
80 * containing XMLBeanInfo definitions for a JavaBean.</p>
81 *
82 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
83 * @version $Revision: 1.1 $
84 */
85 public class XMLBeanInfoDigester extends Digester {
86
87 /*** Logger */
88 private static final Log log = LogFactory.getLog( XMLBeanInfoDigester.class );
89
90 /*** the beans class for this XML descriptor */
91 private Class beanClass;
92
93 /*** should attributes or elements be used for primitive types */
94 private boolean attributesForPrimitives;
95
96 /*** the set of property names processed so far */
97 private Set processedPropertyNameSet = new HashSet();
98
99 /*** the introspector that is using me */
100 private XMLIntrospector introspector;
101
102 /***
103 * Construct a new XMLBeanInfoDigester with default properties.
104 */
105 public XMLBeanInfoDigester() {
106 }
107
108 /***
109 * Construct a new XMLBeanInfoDigester, allowing a SAXParser to be passed in. This
110 * allows XMLBeanInfoDigester to be used in environments which are unfriendly to
111 * JAXP1.1 (such as WebLogic 6.0). Thanks for the request to change go to
112 * James House (james@interobjective.com). This may help in places where
113 * you are able to load JAXP 1.1 classes yourself.
114 */
115 public XMLBeanInfoDigester(SAXParser parser) {
116 super(parser);
117 }
118
119 /***
120 * Construct a new XMLBeanInfoDigester, allowing an XMLReader to be passed in. This
121 * allows XMLBeanInfoDigester to be used in environments which are unfriendly to
122 * JAXP1.1 (such as WebLogic 6.0). Note that if you use this option you
123 * have to configure namespace and validation support yourself, as these
124 * properties only affect the SAXParser and emtpy constructor.
125 */
126 public XMLBeanInfoDigester(XMLReader reader) {
127 super(reader);
128 }
129
130 /*** @return the beans class for this XML descriptor */
131 public Class getBeanClass() {
132 return beanClass;
133 }
134
135 /*** Sets the beans class for this XML descriptor */
136 public void setBeanClass(Class beanClass) {
137 this.beanClass = beanClass;
138 }
139
140
141 /*** @return the set of property names that have been processed so far */
142 public Set getProcessedPropertyNameSet() {
143 return processedPropertyNameSet;
144 }
145
146 /*** Should attributes (or elements) be used for primitive types.
147 */
148 public boolean isAttributesForPrimitives() {
149 return attributesForPrimitives;
150 }
151
152 /*** Set whether attributes (or elements) should be used for primitive types. */
153 public void setAttributesForPrimitives(boolean attributesForPrimitives) {
154 this.attributesForPrimitives = attributesForPrimitives;
155 if ( introspector != null ) {
156 introspector.setAttributesForPrimitives( attributesForPrimitives );
157 }
158 }
159
160 /*** @return the introspector that is using me */
161 public XMLIntrospector getXMLIntrospector() {
162 return introspector;
163 }
164
165 /*** Sets the introspector that is using me */
166 public void setXMLIntrospector(XMLIntrospector introspector) {
167 this.introspector = introspector;
168 }
169
170 // Implementation methods
171 //-------------------------------------------------------------------------
172 protected void configure() {
173 if (! configured) {
174 configured = true;
175
176 // add the various rules
177
178 addRule( "info", new InfoRule() );
179 addRule( "*/element", new ElementRule() );
180 addRule( "*/attribute", new AttributeRule() );
181 addRule( "*/hide", new HideRule() );
182 addRule( "*/addDefaults", new AddDefaultsRule() );
183 }
184
185 // now initialize
186 attributesForPrimitives = true;
187 processedPropertyNameSet.clear();
188 }
189
190 }
This page was automatically generated by Maven